![]() |
VIVE 3DSP Native C Library
ver 1.0.0.0
Audio 3DSP (3D Sound Perception) Native C Library
|
The vive_3dsp_audiosource structure represents the 3D audio source model. More...
#include <vive_3dsp_api/audio_source.h>
The vive_3dsp_audiosource structure represents the 3D audio source model.
|
related |
Enable or disable bypass small signal effect
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| enable | Set true to enable the effect |
|
related |
Create a audio source object. This function must be called to get a source object before calling any other functions that can manipulate audio source property. Default output channel type is stereo.
| api | The audio engine object. |
| type | Input channel type. CHANNELTYPE_MONO for mono and CHANNELTYPE_STEREO for stereo. |
| sampleRate | Sample frequency of the audio source in Hz. |
|
related |
Destroy the specific audio source object.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
|
related |
Turn on/off DRC (dynamic range control) module of a specific audio source. Turn on it to prevent audio clipping of the output buffer.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| enable | Set true to enable the module. Otherwise, set false. |
|
related |
Enable or disable overall effects of the specific audio source object.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| enable | Set true to enable the effect. Otherwise, set false. |
|
related |
This proces function is specified for applying some audio effects except for 3D sound effects on the audio source. For now, graphic EQ and parametric EQ are applied.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| in_buffer | Input audio buffer. It can be either mono or stereo and will be automatically downmixed to mono. |
| out_buffer | Output audio buffer. It will be represented as stereo. |
| sampleLength | Length of process samples. |
|
related |
Enable or disable graphic equalizer effect of the specific audio source object.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| enable | Set true to enable the effect. Otherwise, set false. |
|
related |
Set channel number of the graphic equalizer effect on audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| num | Channel number. |
|
related |
Set the gain of each band of graphic equalizer effect on audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| pGainArray | The array of gain of EQ bands in float. |
|
related |
Enable or disable mute far distant source effect
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| enable | Set true to enable the effect |
|
related |
Enable or disable occlusion effect of the specific audio source object.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| enable | Set true to enable the effect. Otherwise, set false. |
|
related |
Enable or disable parametric equalizer effect of the specific audio source object.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| enable | Set true to enable the effect. Otherwise, set false. |
|
related |
Set channel number of the parametric equalizer effect on audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| num | Channel number. |
|
related |
Set the center frequency of each band of parametric equalizer effect on audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| pFreqArray | The array of center frequencies of EQ bands in float. Its size is 7. |
|
related |
Set the gain of each band of parametric equalizer effect on audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| pGainArray | The array of gains of EQ bands in float. It size is 7; |
|
related |
Set the Q value of each band of parametric equalizer effect on audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| pQArray | The array of gains of EQ bands in float. It size should be 5 since first and last band don't use Q value. |
|
related |
Apply 3D sound effect of the specific audio source object to a buffer of audio data. If the input audio buffer contains more than one channel, it will automatically be downmixed to mono.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| in_buffer | Input audio buffer. It can be either mono or stereo and will be automatically downmixed to mono. |
| out_buffer | Output audio buffer. It will be represented as stereo. |
| sampleLength | Length of process samples. |
|
related |
Enable or disable quasi doppler effect of the specific audio source object.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| enable | Set true to enable the effect. Otherwise, set false. |
|
related |
Reset all the effects on a specific audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
|
related |
Enable or disable revereration effect of the specific audio source object.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| enable | Set true to enable the effect. Otherwise, set false. |
|
related |
Set threshold gain of the bypass small signal effect of specific audio source object.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| gain | Threshold gain. It should be in dB scale. |
|
related |
Set doppler order of the audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| order | Doppler order. |
|
related |
Set output gain of the specific audio source object.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| gain | Output gain. It should be nonnegative and in linear scale. |
|
related |
Set the channel type of the input signal for a specific audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| type | CHANNELTYPE_MONO for mono and CHANNELTYPE_STEREO for stereo. |
|
related |
Set the maximum effective distance of the output signal for a specific audio source. It works in linear decay mode.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| distance | The distance from listener to source. It should be positive or zero. |
|
related |
Set the minimum effective distance of the output signal for a specific audio source. It works in linear decay mode.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| distance | The distance from listener to source. It should be positive or zero. |
|
related |
Set the minimum volume of the output signal for a specific audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| dB | The minimum volume in dB. It should be non-positive. |
|
related |
Set the radius of the mute far distant source effect of specific audio source object.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| radius | Threshold gain. It should be in dB scale. |
|
related |
Set the position of the specific audio source object.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| pos | The 3D position of the audio source object. |
|
related |
Set binaural reverb engine of the audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| mode | Binaural Reverb engine. |
|
related |
Set distance mode of the audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| mode | Distance mode. |
|
related |
Set reverb mode of the audio source.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| mode | Reverb mode. |
|
related |
Enable or disable 3D sound effect of the specific audio source object.
| api | The audio engine object. |
| src | The audio source object created by vive_3dsp_source_create_object. |
| enable | Set true to enable the effect. Otherwise, set false. |
1.8.14